// <copyright file="GaussWindow.cs" company="Math.NET">
// Math.NET Filtering, part of the Math.NET Project
// http://filtering.mathdotnet.com
// http://github.com/mathnet/mathnet-filtering
//
// Copyright (c) 2009-2014 Math.NET
//
// Permission is hereby granted, free of charge, to any person
// obtaining a copy of this software and associated documentation
// files (the "Software"), to deal in the Software without
// restriction, including without limitation the rights to use,
// copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the
// Software is furnished to do so, subject to the following
// conditions:
//
// The above copyright notice and this permission notice shall be
// included in all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
// OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
// WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
// OTHER DEALINGS IN THE SOFTWARE.
// </copyright>

using System;

namespace MathNet.Filtering.Windowing
{
    /// <summary>
    /// Gauss window.
    /// </summary>
    public class GaussWindow : Window
    {
        double _sigma;

        /// <summary>
        /// Create a new gauss window.
        /// </summary>
        public GaussWindow(double sigma)
        {
            _sigma = sigma;
        }

        /// <summary>
        /// Sigma (standard distribution of the Gaussian distribution).
        /// </summary>
        /// <exception cref="ArgumentOutOfRangeException"/>
        public double Sigma
        {
            get { return _sigma; }
            set
            {
                if (0.0 > value || 0.5 < value)
                {
                    throw new ArgumentOutOfRangeException("value");
                }

                _sigma = value;
                Reset();
            }
        }

        /// <summary>
        /// Windowing function generator implementation.
        /// </summary>
        protected override double[] ComputeWindowCore(int width)
        {
            return Numerics.Window.Gauss(width, _sigma);
        }
    }
}
